Passer au contenu principal
GET
/
v1
/
customers
/
{id}
/
usage
/
{aggregator_id}
/
timeseries
Get customer usage timeseries
curl --request GET \
  --url https://api.hyperline.co/v1/customers/{id}/usage/{aggregator_id}/timeseries \
  --header 'Authorization: Bearer <token>'
{
  "timeseries": [
    {
      "tick": "<string>",
      "count": 123
    }
  ],
  "total": 123
}

Autorisations

​
Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

​
id
string
requis
​
aggregator_id
string
requis

Paramètres de requête

​
start_date
string<date-time>
requis

ISO-8601 date string.

Exemple:

"2026-01-01T00:00:00Z"

​
end_date
string<date-time>
requis

ISO-8601 date string.

Exemple:

"2026-02-01T00:00:00Z"

​
aggregator_filter_id
string

Optional aggregator filter ID. When set, restricts the result to events matching that filter's config. Must belong to the aggregator in the path.

​
group_by
enum<string>
défaut:month

Bucket size for the timeseries.

Options disponibles:
month,
day,
hour

Réponse

​
timeseries
object[]
requis
​
total
number
requis